home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1990: Night of the Living Disc / Night of the Living Disc.2mg / Dev.CD.5 / Tools / Documents / STYLE.GUIDE.P2 < prev   
Encoding:
Text File  |  1989-03-21  |  61.3 KB  |  1,056 lines  |  [04] ASCII Text (0x0000)

  1. paddle buttonDon't use; use hand-control button or button on the hand control. 
  2.  
  3. pageThere are two types of pages. See display pages; memory pages. 
  4.  
  5. PALAcronym for Phased Alternate Lines (a European color standard) or for Programmed Array Logic (a type of integrated circuit). Spell out on first occurrence. 
  6.  
  7. paletteNote spelling. 
  8.  
  9. parenthesis (sing.), parentheses (pl.)Note different spelling of singular and plural. See also punctuation. 
  10.  
  11. part opener  Most manuals don't need to be divided into parts; division into chapters is usually sufficient. Good candidates for division into parts would be manuals that describe two or more separate products or two or more mutually exclusive programs on the same disk, or manuals so long that division into parts is necessary to make the organization clearer to the reader. 
  12. Part numbers are always roman numerals: Part I, not Part 1. 
  13.  
  14. partsBooks are divided into parts when each part deals with a distinct topic. Accordingly, parts take part titles to indicate that difference in subject matter. When your manual has parts, use roman numerals for part numbers. 
  15.     Part I, Part II 
  16. In a manual with parts, chapter numbering continues uninterrupted from part to part. 
  17. In cross-references to specific parts, italicize the part title along with the title. Use a colon to separate the title from the part title when you refer to both. Use an em dash to separate the part number from the part title. 
  18.     For more information, see the AppleIIgs System Disk User's Guide: PartII-System Utilities. 
  19. See also volumes. 
  20.  
  21. PascalNote capitalization. 
  22.  
  23. passive voiceWhenever possible, don't use; use active voice. Passive voice is sometimes appropriate and necessary-when using the active voice would require highly convoluted sentence structure or excessive anthropomorphism, for example-but rewrite to avoid passive voice if you can. 
  24. In training disks, a passive construction may be appropriate to avoid miscuing the reader-that is, when describing an action that the user is not supposed to try yet. 
  25.     Explanation screen: An icon is selected by clicking it. 
  26.     User-try screen: You try it. Click the icon. 
  27.  
  28. pathnameOne word. Note the treatment of these similar terms: device name, filename, user name, volume name. 
  29.  
  30. PCGenerally, don't use. Use personal computer for generic references and IBM PC to refer to the IBM personal computer. However, in certain documents-such as networking documents-where frequent references must be made to non-Apple systems, PC may be used to refer to IBM systems and MS-DOS systems. Don't use PC as a generic name for IBM PCs and MS-DOS compatibles without first specifying in the document the use of PC.
  31.  
  32. PC-DOSNote hyphenation and capitalization. 
  33.  
  34. P-codeStands for pseudocode. Note capitalization and hyphenation. 
  35.  
  36. percentOne word. (Exception to AmericanHeritage.) Always preceded by a numeral, no matter how small the value. 
  37.     1 percent 
  38. It's OK to use the percent symbol (%) instead of the word percent in technical appendixes, specification lists, and tables, or when the word must appear so many times in a text passage that its use becomes cumbersome. 
  39. When describing a nonspecific quantity, use percentage, as in a small percentage of the population. 
  40.  
  41. periodsSee ellipsis points. 
  42.  
  43. peripheralAvoid as a noun, especially in user manuals. Use peripheral card or peripheral device. 
  44.  
  45. peripheralcardNot accessorycard. When appropriate, be specific: controller card, interfacecard. Avoid peripheral as a noun, especially in user manuals. 
  46.  
  47. peripheral slotDon't use; use expansion slot. 
  48.  
  49. Phased Alternate Lines (PAL)Refers to a European color standard. Spell out on first occurrence. 
  50.  
  51. Phillipsscrew, Phillips screwdriverNote capitalization and spelling. Not Phillips-head screw or Phillips-head screwdriver.  
  52.  
  53. phone portDon't use; use modem port. 
  54.  
  55. piggyback boardDon't use; use expansion board. 
  56.  
  57. pinAlways use a numeral and a hyphen before pin when describing connectors: 9-pin, 11-pin, 25-pin, 50-pin. (Exception to the rule that numbers smaller than 10 are spelled out except when used as numerals per se.) 
  58.  
  59. pinout (n.)One word.
  60.  
  61. pixelShort for picture element. Not synonymous with bit. Define on first occurrence. 
  62.  
  63. plugNot maleconnector. See also connector. 
  64.  
  65. plurals 
  66. n    acronyms and abbreviations 
  67. To form the plural of an acronym or an abbreviation, add an s but no apostrophe. 
  68.     ICs, RAMs, ROMs 
  69. n    adjectives 
  70. Don't add s to an adjective unless necessary. For example, it's electronic circuit but electronics engineer. Other words that fall into this class of adjectives are graphic and graphics, communication and communications, numeric and numerics. 
  71. n    letters, characters, symbols 
  72. To form the plural of a letter, character, or symbol, add an apostrophe and an s. 
  73.     p's, 6's, +'s 
  74. n    nouns 
  75. Don't use (s) to indicate that a noun can be either singular or plural. Spell out the singular and plural forms if necessary; if possible, rewrite to avoid either construction. 
  76.     Incorrect: Initializing your hard disk(s) 
  77.     Correct: Initializing your hard disk or disks 
  78.     Preferable: Initializing hard disks 
  79. n    product names 
  80. Form the plural of trademarked product names by adding the plural generic noun to the singular product name used as an adjective.
  81.     Incorrect: Macintoshes, Apple IIc's, LaserWriters
  82.     Correct: Macintosh computers, Apple IIc computers, LaserWriter printers 
  83. If a product name includes a generic noun as well as a trademarked adjective, form the plural as you would with any noun. 
  84.     Apple 3.5 Drives, LocalTalk Custom Wiring Kits 
  85. n    words as words
  86. Form the plural of a word italicized to show that it is used as a word by adding an apostrophe and an s. Do not italicize the apostrophe or the s. 
  87.     He had too many and 's in the sentence.  
  88.  
  89. plus signNot plus symbol. 
  90.  
  91. p.m.Note small caps and periods. (Exception to the rule that abbreviations do not include periods.) 
  92.  
  93. P-machineStands for pseudomachine. Note capitalization and hyphenation. 
  94.  
  95. point (n.)Use only when writing about font sizes. Don't use as a synonym for dot or to describe a place or spot on the screen. 
  96. point (v.)When describing the desktop interface, don't use point as a verb without first defining it for the reader.
  97.     First occurrence: Move the mouse to position the pointer on the Trash icon. (This action is called pointing.) Then press the mouse button to select the icon. (This action is called clicking the icon.) 
  98.     Thereafter: Point to the Trash icon and click to select it. 
  99. Once the reader is familiar with basic mouse techniques, it's often not necessary to mention pointing at all. 
  100.     Click the Trash icon or Select the Trash icon. 
  101.  
  102. pointerOK in general references, but be specific whenever appropriate: arrow, crossbar, crosshair, I-beam, wristwatch. (Figure 16 gives an example of each of these pointers.) Not synonymous with cursor. 
  103. n    Figure16    Pointers 
  104.     
  105.     
  106.     
  107.     
  108.  
  109. pop up (v.), pop-up (adj.)Note hyphenation of adjective. 
  110.  
  111. portOK only for a socket on the back of the computer. Don't capitalize the names of the ports: modem port, mouse port, printer port, SCSI port. 
  112.  
  113. possessivesForm the possessive of a singular noun, including one that ends in s, by adding an apostrophe and an s. 
  114.     the computer's power cord 
  115.     the boss's husband 
  116. Form the possessive of a plural noun that ends in s by adding an apostrophe. Form the possessive of a plural noun that does not end in s by adding an apostrophe and an s. 
  117.     the students' curriculum 
  118.     children's requirements
  119. Form the possessive of a proper noun or a proper name, including one that ends in s, by adding an apostrophe and an s. Form the possessive of a plural proper noun or proper name by adding an apostrophe. 
  120.     Howard Hughes's official biography 
  121.     the Joneses' computer 
  122. Rewrite to avoid forming a possessive of any product name, especially a product name such as Apple IIc, Apple IIgs, or Macintosh II. 
  123.  
  124. PostScriptNote capitalization. However, this name should be in caps and small caps when it appears on the copyright page or in the colophon. 
  125.  
  126. pound signDon't use; use number sign for this character: #. 
  127.  
  128. power cordNot power cable. 
  129.  
  130. power-down (n., adj.), power down (v.)OK in technical manuals. Don't use in user manuals; use switch off. 
  131.  
  132. power off (v.)Don't use, especially in user manuals; use switch off. 
  133.  
  134. power on (v.)Don't use, especially in user manuals; use switch on. 
  135.  
  136. power-onlightNote hyphenation and lowercase. 
  137.  
  138. power-up (n., adj.), power up (v.)OK in technical manuals. Don't use in user manuals; use switch on. 
  139.  
  140. pre (prefix)Close up even when it forms a double vowel, as in preexisting. 
  141.  
  142. preface  Not all manuals need a preface, but it's often a good idea to include one, especially in longer manuals.  
  143. The preface can be used to tell the reader about the manual, to describe conventions such as special notation and boldfacing defined terms, and to outline what the reader will find where. As a rule, discussion of the product belongs in the text, not in the preface, although it is sometimes appropriate to include introductory information about the product in the preface. 
  144. The preface should have a title. "About This Manual" is often appropriate. 
  145. When referring to the preface of a manual (but not when referring to prefaces in general), capitalize the word preface.
  146.     See the Preface for more information.
  147. The preface always begins on a new right-hand page. The first page has a page number but no running foot; all subsequent pages have a page number and a running foot. (Running feet follow the standard text convention: "Preface: Preface Title" on left-hand pages, "Level-one head" on right-hand pages.)
  148. presetMay be used to describe a default setting. 
  149.  
  150.     MacWrite provides you with a ruler that has preset margins. 
  151. pressUse for keys on the keyboard, the mouse button, and mechanical buttons and switches. Don't use click, hit, tap, or type. 
  152.     Press the Return key. 
  153.     Press Command-Q to quit HyperCard. 
  154. See also click; enter; type. 
  155.  
  156. print (v.)Not print out. 
  157.  
  158. printed-circuit boardNote hyphenation. 
  159.  
  160. printer portNote lowercase. 
  161.  
  162. printheadTwo words. 
  163.  
  164. printout (n.)One word. 
  165.  
  166. print out (v.)Don't use; use print. 
  167.  
  168. print serverTwo words. 
  169.  
  170. printwheelTwo words. 
  171.  
  172. productnamesFollow the capitalization style on the product's packaging. Don't use quotation marks around product names. 
  173. When you use a t or a r symbol, the product name must be an adjective. 
  174.     Apple Desktop Bust device 
  175.     Macintoshr computer 
  176. See also trademarks. 
  177.  
  178. ProDOSUse only for the family of operating systems, which includes ProDOS 8 and ProDOS 16, or to refer to the ProDOS file system, which is used by both ProDOS 8 and ProDOS 16. 
  179.  
  180. ProDOS 8Use for the original member of the ProDOS family, which was called just ProDOS before ProDOS 16. 
  181.  
  182. ProDOS 16Use for the operating system developed for the Apple IIgs. 
  183.  
  184. product training disksFollow the general rules given in this style guide, with the following exceptions: 
  185. n    Use quotation marks, not italics, for words as words, letters as letters, and phrases as phrases, and for manual and disk titles.
  186. n    Use boldface, if available, for what the user is to type.
  187. n    Use underlining, not italics, for emphasis and for new terms. (If underlining is not available, use all caps.) 
  188.  
  189. programlistingsUse computer voice. 
  190.  
  191. Programmed Array Logic (PAL)Spell out on first occurrence. 
  192.  
  193. programnamesDon't use computer voice. Capitalization should agree with the directory or catalog listing. Don't confuse a program name with a product name. 
  194.     One of the program files used for AppleWorks is named APLWORKS.SYSTEM. 
  195. See also product names. 
  196.  
  197. prompt (n., v., adj.)Avoid as a verb except in reference to what the system does when it displays an actual prompt character on the screen. 
  198.     The prompt reminds you to do something. 
  199.     The system then prompts you for information [with a prompt character]. 
  200.     The prompt character is sometimes a bracket. 
  201.  
  202. pronunciationWhenever the pronunciation of an acronym is not self-evident, it's a good idea to give a pronunciation key. Use all caps for the stressed syllable; use a hyphen between syllables. Enclose the phonetic spelling in quotation marks. 
  203.     SCSI (pronounced "SKUH-zee") 
  204. The Apple Publications Glossary provides pronunciation keys for many acronyms; don't invent your own pronunciation key unless the pronunciation isn't given in that document. 
  205.  
  206. propellerNot propellor. 
  207.  
  208. pseudo (prefix)Close up except before o, a proper noun, or a proper adjective. (Hyphenate in those cases.)  
  209.  
  210. pulldown (v.), pull-down (adj.)Note hyphenation of adjective. 
  211.  
  212. punctuationIn general, a punctuation mark should be in the same type style and font as the preceding word. 
  213.     This address, called a vector, directs program control to a specified destination. [The second comma is italicized.] 
  214.     See the glossary for the definition of word wrap. [The period is boldfaced.] 
  215. Note the following exceptions to this rule:
  216. n    Punctuation following computer voice in running text should be in the font of the overall sentence, not in computer voice, unless the punctuation mark is part of what actually appears on the screen or in the program listing.
  217. n    A closing parenthesis, bracket, or quotation mark should be in the same style as the opening mark. (For example, a closing parenthesis following an italicized word should be in plain style, not italic, unless all text between the parentheses is italicized.) 
  218. n    When forming the plural of an italicized letter used as a letter, a number used as a number, or a word used as a word, neither the apostrophe nor the s is italicized. 
  219. For punctuation of lists, see list. 
  220. See also apostophes; commas; dashes; ellipsis points; hyphenation; quotation marks. 
  221.  
  222. QuickDrawOne word. Note capitalization. 
  223.  
  224. Quick Reference CardA copyright notice should appear on all Quick Reference Cards:
  225.     Copyright c <year> Apple Computer, Inc. All rights reseved.
  226.  
  227. quitYou quit, exit from, or leave a program. You never exit a program. Compare abort; cancel; halt; interrupt; stop. 
  228.  
  229. quotationmarksUse curly opening and closing quotation marks except in computer voice and for Macintosh resource types in any font. (Table 4 gives the keystrokes necessary to generate curly quotation marks.) 
  230. Put periods and commas within quotation marks. If necessary for clarity, periods and commas can go outside, as in AN$="1". Semicolons, colons, question marks, and exclamation points go outside quotation marks unless they are part of an actual quotation. 
  231. When giving the name of a resource type, use straight single quotation marks in computer voice and place any punctuation outside the quotation marks. 
  232.     Examples of resource types are 'FONT', 'NFNT', and 'cdev'. 
  233. Use quotationmarks, not quotemarks or quotes. (Quote is a verb; quotation is a noun or an adjective.) 
  234. Use quotation marks for 
  235. n    cross-references to other sections of the manual
  236.     See "Maintenance" at the end of this chapter.
  237. n    cross-references to chapter titles
  238.     See Chapter 2, "Using MacProject." 
  239. n    direct quotations
  240. n    letters as letters and words as words in product training disks
  241. n    manual and disk titles in product training disks 
  242. In manuals, use italics, not quotation marks, for terms after called, knownas, labeled, stands for, termed, and so on. (Use underlining for this purpose in training disks.) If a term is an on-screen element, however, don't use italics or underlining; use plain style for elements whose names are caps/lowercase, quotation marks for elements whose names are initial cap only.
  243.     INIT stands for initialize. 
  244.     A folder named New Folder appears. 
  245.     Click the check box labeled "Keep lines together." 
  246. n    Table 4    How to generate curly quotation marks 
  247. ___________________________________________________________
  248. Variety      Keystroke 
  249. __________________________________________________________
  250. Single opening ( ' )    Option-] (right bracket) 
  251. Single closing or apostrophe ( ' )    Option-Shift-] (right bracket) 
  252. Double opening ( " )    Option-[ (left bracket) 
  253. Double closing ( " )    Option-Shift-[ (left bracket) 
  254.  
  255. racism, racist languageSee fair language. 
  256.  
  257. Fig17
  258.  
  259.  
  260.  
  261. radio buttonRefers to an on-screen button like the ones shown in Figure 17. Use only in technical documentation; use button in user manuals. No quotation marks around radio; no hyphen. See also button. 
  262.  
  263. radio-frequency interference (RFI)Note hyphenation. Spell out on first occurrence. 
  264.  
  265. radio-frequency(RF)modulatorNote hyphenation. Use RFmodulator only after spelling out on first occurrence. 
  266.  
  267. RAMAcronym for random-access memory. Spell out on first occurrence. 
  268.  
  269. RAM cache (n.)Lowercase c except when referring specifically to the Ram Cache option in the Control Panel. 
  270.  
  271. RAM diskTwo words. Note capitalization. 
  272.  
  273. random-accessmemory (RAM)Note hyphenation. Spell out on first occurrence. 
  274.  
  275. re (prefix)Usually closed up, even when it forms a double vowel, as in reenter. Exception: re-create (as in re-create the file). 
  276. read-onlymemory (ROM)Note hyphenation. Spell out on first occurrence. 
  277.  
  278. read/write (adj)Note slash, as in read/write memory. 
  279.  
  280. real time (n.), real-time (adj.)Note hyphenation of adjective.
  281.  
  282. referenceDon't use as a verb; use refer to. 
  283.  
  284. registerCapitalize names of specific registers, but don't capitalize the word register. Don't capitalize generic register names such as bank register and control register. 
  285.  
  286. ResetThe key, which may be labeled with the word Reset or with a triangle symbol. 
  287.  
  288. resizeNot size or grow. OK to write change the size of. 
  289.  
  290. resize boxDon't use; use size box. 
  291.  
  292. resources and resource typesA resource type name should be in computer voice and must have exactly four characters inside straight single quotations marks; for example, 'INIT', 'crsr', 'ICN#', and 'snd '. Resources themselves are often referred to by the same abbreviation as their resource type, but in a generic way; use regular text font in this case. Be sure to explain the abbreviation on first use. Avoid using the resource type name abbreviation unnecessarily.
  293.     Incorrect: Format 1 and format 2 snd resources . . .
  294.     Correct: Format 1 and format 2 sound resources . . .
  295.     Correct: Format 1 and format 2 'snd ' resources . . .
  296.     Correct: All initialization resources, or INIT resources, are of type 'INIT'.
  297.     Correct: Resources of type 'XCMD' are HyperCard external commands (also called ex-commands or XCMDs). When you write XCMDs . . .
  298.     Correct: To be adopted by the Control Panel, a cdev file must contain at least these resources: 'DITL', 'mach', . . .  and 'cdev'.
  299.  
  300. ReturnThe key. 
  301.     When you press Return, you generate a return character. 
  302. In technical manuals, it's OK to use the Return symbol ( o ) in lines of code and in tables. (To generate a Return symbol, press Option-O in 10-point Symbol.) 
  303.  
  304. return characterNot carriage return or CR except in technical documentation when referring to ASCII character $0D. See also carriage return (CR). 
  305.  
  306. RFIAbbreviation for radio-frequency interference. Spell out on first occurrence. 
  307.  
  308. Right ArrowThe key. When referring to more than one of the arrow keys, arrow is lowercase (as in the arrow keys). 
  309.  
  310. right-handAvoid except in reference to right-hand (recto) pages; use just right whenever possible. 
  311.  
  312. rightmostNo hyphen. 
  313.  
  314. right sideNot right-hand side. 
  315.  
  316. road mapTwo words. 
  317.  
  318. ROMAcronym for read-only memory. Spell out on first occurrence. 
  319.  
  320. ROM diskTwo words. Note capitalization. 
  321.  
  322. rowUse in describing a system that uses a grid of horizontal rows and vertical columns for placement of characters on the screen. Compare character position. 
  323.  
  324. RS-242Note hyphenation.
  325.  
  326. RS-232-CNote hyphenation. Similar terms are hyphenated in the same way. 
  327.  
  328. running feet   The first page of each major division (front matter elements, chapters, appendixes, glossary, bibliography, and index) has a page number but not a running foot. All subsequent pages of the division have running feet.
  329. In a book with chapters, running feet on left-hand pages consist of the word Chapter, the chapter number followed by a colon, and the chapter title in caps/lowercase. Running feet on right-hand pages consist of the most recent level-one head, in initial cap only. For example:
  330.     left-hand page    Chapter 3: Putting Your Apple IIgs to Work
  331.     right-hand page    Saving documents    
  332. In a chapter without level-one heads, use Chapter, the chapter number, colon, and chapter title for running feet on both right-hand and left-hand pages. For example:
  333.     both pages    Chapter 3: Installing a Network Using LocalTalk Cables
  334. In a manual without chapters, use the manual title (caps/lowercase) for running feet on left-hand pages, and the most recent level-one head (initial cap only) for running feet on right-hand pages. 
  335.     left-hand page    AppleColor High-Resolution RGB Monitor
  336.     right-hand page    Positioning your monitor
  337.  
  338. run time (n.), run-time (adj.)Note hyphenation of adjective. 
  339.  
  340. "sad Macintosh"Refers to the startup icon. Use quotation marks. Not sad Mac. 
  341.  
  342. sans serif (adj.)No hyphen. Not sanserif. 
  343.  
  344. save boxDon't use; use close box. 
  345.  
  346. save on a diskNot save to disk. 
  347.  
  348. ScrapbookThe desk accessory. Note capitalization. 
  349.  
  350. screenNot display. 
  351.  
  352. scrollAvoid using as a transitive verb.
  353.     Correct: Scroll through a document.
  354.     Correct: Scroll to view more of the document.
  355.     Incorrect: Scroll a document.
  356.  
  357. scroll boxTwo words. 
  358.  
  359. SCSIAcronym for Small Computer System Interface. Spell out on first occurrence. The acronym is pronounced "SKUH-zee," so it is preceded by a, not an.
  360.     The Hard Disk 20 SC is a SCSI device. 
  361. SCSI cableNot SCSI system interface cable or SCSI interface cable. Be specific: SCSI system cable, SCSI peripheral cable. 
  362.  
  363. SCSI cardNot SCSI interface card. 
  364. SCSI ID indicatorNot SCSI priority switch. 
  365. SCSI ID numberNot SCSI priority number. 
  366. SCSI ID switchNot SCSI priority switch setter or SCSI ID number switch. 
  367.  
  368. SE Bus access portNo hyphen. Not accessory access port. 
  369.  
  370. select Use select, not choose, for icons, windows, objects, graphic images, sections of text, or options in dialog boxes. Use choose for menu commands, including those in tear-off menus. See also choose. Compare deselect; highlight; unselected. 
  371.  
  372. self-test (n., adj.)Note hyphenation. Don't use as a verb. 
  373.  
  374. Serial A, Serial BPorts on the Macintosh XL. Note capitalization. 
  375.  
  376. setup (n., adj.), setup (v.)One word except as a verb. 
  377.  
  378. sexism, sexist languageSee fair language.
  379.  
  380. ShiftThe key. Note capitalization. 
  381.  
  382. Shift-click (n., v., adj.)Note capitalization and hyphenation. (The hyphen denotes a combined keystroke.) 
  383.     Small children may have trouble with the Shift-click. 
  384.     Shift-click to extend the selection. 
  385.     Use the Shift-click technique to select more than one icon. 
  386.  
  387. Shift lockDon't use; use Caps Lock. 
  388.  
  389. shortcutOne word. (Exception to American Heritage.) 
  390.  
  391. signUse sign, not symbol, in the following terms: division sign, equal sign, greater-than sign, less-than sign, minus sign, multiplication sign, number sign, and plus sign. 
  392.  
  393. signaled,signalingNot signalled,signalling. 
  394.  
  395. signalsUse regular text font all caps for signal names. Use an en dash between the first and last signal names to indicate a range of signals. Begin active-low signal names with a slash, and use angle brackets to enclose two or more ranges in a set. 
  396.     /CLK 
  397.     </AD31-AD29,/AD7-/AD0> 
  398.  
  399. SIMMAcronym for Single In-line Memory Module. Spell out on first occurrence. 
  400.  
  401. sinceCan be used to mean because, but only if it begins a sentence. When using since in this way, however, make sure it isn't possible to misread the sentence as an expression of temporal relationship. 
  402.     Correct: Since the address is passed on every call, you must . . . 
  403.     Incorrect: Using access privileges is a good idea, since you probably won't want all users to make changes to the document. 
  404.  
  405. Single In-line Memory Module (SIMM)Note capitalization. Note lowercase l. Spell out on first occurrence. 
  406.  
  407. singlelettersSee letters as letters. 
  408.  
  409. 68000, 68020, . . . No comma. Don't use 68K for 68000. On first occurrence, use Motorola 68000 microprocessor; thereafter, the manufacturer need not be mentioned. See also x.  
  410.  
  411. size (v.)Don't use; use resize or change the size of (in reference to a window or an object). 
  412.  
  413. size boxTwo words. Not grow box or resize box. 
  414.  
  415. size regionDon't use; use grow region. 
  416.  
  417. sleeveDon't use. Use envelope or disk envelope to describe the paper holder for a 5.25-inch disk. Use jacket to describe the permanent cover that encases a 5.25-inch floppy disk. 
  418.  
  419. slot1, slot 2, . . .Lowercase. Slot number is arabic. 
  420.  
  421. SmartPortOne word. Note capitalization. 
  422.  
  423. so-called (adj.)Don't italicize or use quotation marks around terms following so-called. 
  424.  
  425. socketNot femaleconnector. See also connector; port. 
  426.  
  427. Solid Apple keyDon't use; use Option key for the key marked with a solid Apple on Apple II-family keyboards that have two keys with Apple symbols. 
  428. If your manual may be read by users who are familiar with the term Solid Apple key, it's a good idea to explain the change in terminology.  
  429.  
  430. source fileTwo words, except in reference to the Pascal predefined file type sourcefile. 
  431.  
  432. Space barTwo words. Note capitalization. 
  433.  
  434. spacecharacterNot blank or blankcharacter. OK to use just space, but in many cases it's necessary to remind the user that a space is actually a character and that margins, indention, word wrap, and page breaks can sometimes be affected by extra space characters (or a lack of them). 
  435.  
  436. splashscreenDon't use; use openingdisplay, startup display, or startup screen. 
  437.  
  438. square wave (n.), square-wave (adj.)Note hyphenation of adjective. 
  439.  
  440. stand-alone (adj.)Note hyphenation. Don't use as a noun. 
  441.  
  442. standard file dialog boxDon't use; use directory dialog box.
  443.  
  444. standard Apple IIRefers to any Apple II-family computer except the Apple IIgs. 
  445.  
  446. start up (v.), startup (adj.)Avoid as a noun, especially in user manuals. 
  447.     Start up the Macintosh. 
  448.     Insert the startup disk. 
  449. See also boot. 
  450.  
  451. startup diskPreferred term, but boot disk is OK in technical manuals. 
  452.  
  453. startupdisplay, startup screenNot splash screen; startup display, startup screen, and openingdisplay are all OK. 
  454. statementNot necessarily the same as line. One line may contain several statements, and one statement may extend over several lines. 
  455.  
  456. state namesUse the two-letter abbreviations shown in Table 5. (Both letters are capitalized in these abbreviations.) 
  457.  
  458. n    Table 5    Abbreviations for state names and territories
  459. ____________________________________________________________
  460. State      Abbreviation      State      Abbreviation 
  461. ____________________________________________________________
  462. Alabama      AL      Nebraska      NE 
  463. Alaska      AK      Nevada      NV 
  464. Arizona      AZ      New Hampshire      NH 
  465. Arkansas      AR      New Jersey      NJ 
  466. California      CA      New Mexico      NM 
  467. Colorado      CO      New York      NY 
  468. Connecticut      CT      North Carolina      NC 
  469. Delaware      DE      North Dakota      ND 
  470. District of
  471. Columbia      DC      Ohio      OH 
  472. Florida      FL      Oklahoma      OK 
  473. Georgia      GA      Oregon      OR 
  474. Hawaii      HI      Pennsylvania      PA 
  475. Idaho      ID      Puerto Rico      PR 
  476. Illinois      IL      Rhode Island      RI 
  477. Indiana      IN      South Carolina      SC 
  478. Iowa      IA      South Dakota      SD 
  479. Kansas      KS      Tennessee      TN 
  480. Kentucky      KY      Texas      TX 
  481. Louisiana      LA      Utah      UT 
  482. Maine      ME      Vermont      VT 
  483. Maryland      MD      Virginia      VA 
  484. Massachusetts      MA      Virgin Islands      VI 
  485. Michigan      MI      Washington      WA 
  486. Minnesota      MN      West Virginia      WV 
  487. Mississippi      MS      Wisconsin      WI 
  488. Missouri      MO      Wyoming      WY 
  489. Montana      MT 
  490. stepDon't capitalize, even in specific references. 
  491.     step1, steps1and2, several steps 
  492.  
  493. stereotypesSee fair language. 
  494.  
  495. stopA general term meaning to cause a process, command, or program to cease. Compare abort; cancel; exit; halt; interrupt. 
  496.  
  497. style (of type)Not typestyle or type style. 
  498.  
  499. subdirectoryWhen describing the desktop interface in a user manual, use folder. See also folder. 
  500.  
  501. Fig18
  502.  
  503.  
  504.  
  505. submenuUse when describing hierarchical menus (see Figure18).  When the user drags the pointer to the side of a hierarchical menu command with a triangular indicator, a submenu appears. 
  506. subtitles, manualSee parts; volumes. 
  507. super high resolution (n.), super high-resolution (adj.)Note hyphenation in adjective. 
  508.  
  509. Super Hi-ResRefers to the RGB high-resolution graphics displays on the Apple IIgs. 
  510.  
  511. switch off, switch onPreferred to turn on and turn off. Don't use power down, power off, power on, or power up in user manuals. 
  512.  
  513. symbolOK in a generic sense, as in the percent symbol (%). Don't use symbol when you mean character, letter, or digit. 
  514. Use sign, not symbol, in the following terms: division sign, equal sign, greater-than sign, less-than sign, minus sign, multiplication sign, number sign, and plus sign.
  515.  
  516. syntax descriptionsUse computer voice for literals (parts of the language, values, and so on), regular text font italics for metasymbols (artificial terms that have meaning only in your book and are to be replaced by a value or symbol), and plain style regular text font for brackets that enclose something that's optional. Pay close attention to punctuation. 
  517.     Read ([file, ] var) 
  518. Use a hyphen or an embedded cap to connect two words that act as a single metasymbol. 
  519.  
  520. n    Figure 19The System file icon 
  521.     
  522.  
  523.     Correct: source-file or sourceFile
  524.     Incorrect: sourcefile or source_file 
  525. The hyphen is preferred to the embedded cap because it avoids confusion of the metasymbol with a Macintosh routine name. 
  526. Be consistent when naming metasymbols; for example, don't alternate between commands and command-list. 
  527.  
  528. systemUse as a broad term; a system includes a computer and any peripheral devices, accessories, and software. 
  529.  
  530. n    Figure 20The System Folder icon 
  531.  
  532. System fileNote capitalization. Refers to the specifically named file (see Figure 19) in the System Folder. Compare system files. 
  533.  
  534. system filesLowercase. Refers to any files used by the Macintosh to start itself up or to provide system-wide information. Compare System file. 
  535.  
  536. System FolderNote capitalization. (See Figure 20.) 
  537.  
  538. systemsoftwareNot systemssoftware. 
  539.  
  540.  
  541.  
  542.  
  543. Tab, tabCapitalize when referring to the key; use lowercase when referring to the character. 
  544.     When you press Tab, you generate a tab character. 
  545.     The tab character (HT, for horizontal tab) has ASCII value $09.
  546.  
  547. table  Use tables whenever numbers or text would be clearer if presented in rows and columns.
  548. Capitalization style for all parts of a table is initial cap only. 
  549. Column heads, spanners (heads to which at least two column heads are subordinate), row titles (heads in the leftmost column), and stubs (heads to which at least two row titles are subordinate) should be short and descriptive. 
  550. If it's necessary to subdivide a single table into sections, use horizontal rules to do so. 
  551.  
  552. table caption  Table captions include both a table number and a table title. Every table must have a caption; if a table is so simple that it needs no title, it should be reformatted as a multicolumn list. 
  553. Tables are numbered one-up by chapter. The table number consists of the word Table, the chapter number (or the letter P if the table is in the preface, or the letter of the appendix if the table is in an appendix), a hyphen, and the number of the table within the chapter. There is no punctuation following the table number. 
  554.     Table P-1 [first table in the preface]Table 8-9 [ninth table in Chapter 8]Table C-5 [fifth table in Appendix C]
  555. Table titles should be short and to the point; a line and a half should be considered the absolute maximum. Avoid using complete sentences for table titles. 
  556. Avoid changing type styles and fonts in table titles; for example, avoid using computer voice. 
  557. Capitalization style for table titles is initial cap only; there is no ending punctuation. 
  558. When a table continues onto a second page (either right-hand or left-hand), the table number is repeated, followed by the word continued in parentheses (all lowercase); the table title, rules, spanners, and column heads are also repeated. If the table will continue onto a left-hand page, the word continued (all lowercase) is also set at the bottom of the page that is being continued.
  559. All tables should have an in-text reference to point the reader to the appropriate table at the appropriate point. In general, this reference belongs in the paragraph preceding the table. (Don't use references such as the table below; the vagaries of page breaks are such that the reference may fall at the bottom of a right-hand page and the table at the top of the following left-hand page.) 
  560. In-text references can follow five styles: 
  561. n    standing alone as a complete sentence within parentheses: (See Table A-12.) 
  562. n    at the end of the text sentence, in parentheses: Many menu commands have power-key equivalents (see Table 5-1).
  563. n    standing alone as a complete sentence without parentheses: See Table 5-5. 
  564. n    standing alone as a sentence fragment within parentheses: The keyboard shortcuts (Table 7-3) allow you to choose commands without pulling down the menu. 
  565. n    part of the main text sentence, without parentheses: The meanings of the different DIP switch positions are shown in Table 5-20. 
  566. You can use any combination of these styles, but be consistent for comparable purposes. 
  567.  
  568. table notes and table footnotes  Information that pertains to an entire table is generally set as a table note, before any table footnotes. 
  569. The table note begins with the word Note (initial cap only) followed by a colon. If it is essential that this information be more prominent than a table note allows, it can be added instead after the table title, in parentheses, with no capitalization or ending punctuation (even if it is a complete sentence). 
  570. When specific items within a table require footnotes, use the following symbols, in this order: 
  571.     asterisk (*)
  572.     dagger (t,Option-t)
  573.     double dagger (|,Option-Shift-7 in the LaserWriter fonts Helvetica, Times, Courier, and Garamond)
  574.     section ($,Option-6)
  575.     paragraph (P,Option-7)
  576.     number (#)
  577. The symbols *, t, and # are already superscript. The symbols |, $, and P need to be selected and made superscript. When more symbols are needed, they are doubled, in the same order. 
  578. tableofcontentsMost manuals of ten pages or more should have a table of contents, which always begins on a new right-hand page (almost always page iii). 
  579. The first page of the table of contents has a page number but no running foot; all subsequent pages have both a page number and the running foot "Contents" (for both right-hand and left-hand pages). 
  580. The table of contents should include part, chapter, and chapter-equivalent titles and all level-one, level-two, and level-three heads. If absolutely necessary, level-four heads can be included (but remember that a book long enough to need level-four heads will also have an index, and that most readers rely on the index rather than the table of contents when they want to locate a specific topic). 
  581. The wording, capitalization, punctuation, and spelling of all heads and titles must be exactly the same in the text as in the table of contents. 
  582. See also chapter tables of contents.
  583.  
  584. tag box  Use a Warning tag box when the reader should be warned that an action on his or her part may cause bodily injury, damage to hardware or software, or loss of data. 
  585. Use an Important tag box to alert the reader to less serious-but still significant-potential trouble spots. 
  586. Use tag boxes sparingly; they lose much of their effectiveness if they appear too often. Don't use one tag box immediately after another, or immediately before or after an incidental box. (See incidental box.) Avoid sandwiching just a few lines of text between two tag boxes, or between a tag box and an incidental box. Don't use a tag box immediately after a text head. 
  587. Under normal circumstances, the only allowable tag words are Warning and Important. It is sometimes appropriate to use a machine-specific tag such as Apple IIe or Original Macintosh. If you have a compelling reason for using another tag word, discuss the situation with your editor. 
  588.  
  589. tapDon't use when you mean press. See also click; press; type. 
  590. TeachTextOne word. Note capitalization. 
  591.  
  592. Fig21
  593.  
  594.  
  595. tear-off menuRefers to a menu that can be removed from the menu bar and left on the desktop either as a list of commands or as a palette. (See Figure 21.) Note hyphenation. 
  596.  
  597. telecommunicationTelecommunication refers to the act; telecommunications refers to the field. When used as an adjective, the correct term is telecommunications. 
  598.     Telecommunication gets simpler by the day, though you can't prove it by most manuals on this subject. 
  599.     The telecommunications industry is expanding rapidly. 
  600. televisionNot television set or TV set. After the first occurrence, TV  is OK. Compare videomonitor. 
  601.  
  602. television monitorDon't use. Use video monitor on first mention; thereafter, monitor is OK. 
  603.  
  604. textfileTwo words, except in reference to the Pascal predefined file type textfile. 
  605.  
  606. text head  Use different levels of text heads to make the organization of a manual clearer to the reader, but remember that too many heads too close together will distract the reader and make for a cluttered page. 
  607. In general, organize your sections so that level-four heads are subordinate to level-three heads, level-three heads to level-two heads, and so on. (Don't skip a level of heads.) When the next logical level of heading seems too prominent for a given usage (in troubleshooting chapters, for example), try to use display sentences rather than skipping a level of text heads. 
  608. Don't begin a chapter with a level-one head; start with an introductory paragraph or two before your first text head. Likewise, don't place a level-two head immediately after a level-one head, and so on. (A brief overview of a section-even if it's only a sentence-is useful before you begin using the next level of text head.) 
  609. If you use a particular level of head at all in a given chapter or section, use at least two. (Strictly speaking, a chapter or section can't be subdivided into only one part.) 
  610. The wording of parallel heads within a section should be parallel: verb forms should be the same (gerunds, imperatives, and so on) from head to head; comparable terms should all be either singular or plural, not a mix; and if you're using complete sentences for some heads, use them for all comparable heads. 
  611. Avoid cute, flippant, or gimmicky heads. Humor can be an effective means of enhancing the reader's experience, but it generally works best in the text rather than in titles or heads. Count on your prose to create the excitement necessary to carry the reader along; keep heads simple and descriptive. 
  612. The capitalization style for all levels of text heads is initial cap only. Avoid colons in heads whenever possible. If a colon in a head is required, capitalize the first word after the colon. 
  613. Cross-references to text heads are in caps/lowercase. 
  614.  
  615. thatUse to introduce a restrictive clause; clauses beginning with that are generally not set off with commas. Compare which. 
  616.     Correct: This is the house that Jack built. [There are many houses; the phrase that Jack built restricts (narrows the meaning of) the subject of the sentence to one house.] 
  617.     Correct: The largest house in town, which Jack's sister built, is also the newest. [There is only one largest house; the phrase which Jack's sister built, while it provides more information, does not restrict the subject of the sentence.] 
  618. 3.5Not 31/2 when referring to 3.5-inch disks. 
  619.  
  620. time-consuming (adj., pred. adj.)Note hyphenation.  
  621. title barTwo words. Note lowercase. 
  622.  
  623. titledNot entitled. 
  624.  
  625. title page  All manuals must have a title page. This page is the first in the book (page i) and does not have a page number or a running foot. 
  626. Any trademarked Apple product whose name appears on the title page must receive the appropriate trademark symbol (r or t). Unlike trademark symbols in running text, the symbols on the title page align with the base of the product name. For information on trademark symbols, see trademarks. 
  627. titles, chapterandsectionMake part titles, chapter titles, and heads concise and consistent. Keep the reader's needs in mind, and remember that these elements are used primarily as locators for someone scanning through a manual. 
  628. For functional definitions of design elements, see the appropriate specifications for designs such as Galaxy and Nova. 
  629.  
  630. titles, diskSee disk titles. 
  631.  
  632. titles, manualSee manualtitles. 
  633.  
  634. token ring networkThree words.
  635.  
  636. toolkitTwo words. 
  637.  
  638. top leftAvoid; use upper left as a noun, upper-left as an adjective. 
  639.  
  640. top rightAvoid; use upper right as a noun, upper-right as an adjective. 
  641.  
  642. towardNot towards. 
  643.  
  644. trademarksAny trademarked Apple product mentioned in a manual must receive the appropriate trademark symbol (r or t) on first occurrence both in the preface and in the text. (Mentions in front matter other than the preface do not receive a trademark symbol.) Any trademarked product name that appears on the title page must receive the appropriate symbol both on the title page and on first occurrence in the preface and in the text. 
  645. The following uses of a name do not constitute first occurrence in text and should not receive a trademark: in a manual title used in a text cross-reference, in a heading, in a caption for a table or figure, in a marginal gloss. 
  646. Credit lines for all trademarked products (third-party as well as Apple) must be given on the copyright page. 
  647. Trademark status changes with time; for the most current listing of Apple trademarks, consult the monthly trademark and copyright update published by Apple's Legal Department. 
  648. Trademarked non-Apple products do not receive a trademark symbol in the text unless the trademark owner has entered into a special licensing agreement with Apple. (The trademark and copyright update lists all such licensed trademarks.) For licensed third-party trademarks, as for Apple trademarks, include the appropriate symbol on first occurrence in the preface and in the text. 
  649. When a product name is a trademarked term, it should be used as an adjective modifying a generic noun on first occurrence in the preface and in each chapter. 
  650.  
  651. training disksSee product training disks. 
  652.  
  653. troubleshoot (v.), troubleshooting (n., adj.)One word. 
  654.  
  655. TVNot TV set or television set. Use television on first occurrence. Compare videomonitor. 
  656.  
  657. TV monitorDon't use. Use video monitor on first mention; thereafter, monitor is OK. 
  658.  
  659. 25-pin connectorNote hyphenation. In user manuals, use instead of DB-25 connector. See also connector. 
  660.  
  661. type (n.)Use in general references to the text that appears on a printed page. Don't use type when you mean font or font family. 
  662.  
  663. type (v.)Use to describe the act of pressing keys to produce characters on the screen. In manuals, use computer voice to represent what the user actually types, regular text font to describe generically what the user types. In tour disks, use boldface rather than computer voice. 
  664.     Type PR#4. 
  665.     Type Hello. 
  666.     Type your name. 
  667. Compare enter; press. 
  668.  
  669. type-ahead (n., adj.), type ahead (v.)No hyphen in verb. Refers to the queuing of a user's keystrokes until an application is ready to process them. Compare mouse-ahead; mouse ahead. 
  670.  
  671. typefaceDon't use; use font or font family, whichever is appropriate. 
  672. type familyDon't use; use font family. 
  673.  
  674. type sizeDon't use; use size or font size.
  675.   
  676. uncheckDon't use; use deselect.
  677.  
  678. underliningDon't use in manuals. In training disks, use underlining instead of italics for emphasis and for new terms. (If underlining is not available, use all caps.) See also boldface; italics; quotation marks. 
  679.  
  680. unhighlight (v.)Don't use when you mean deselect. 
  681.  
  682. unhighlighted (adj.)Don't use; use not highlighted. Compare unselected. 
  683.  
  684. UNIXrsystemA registered trademark of AT&T Information Systems. All caps, but not an acronym. UNIX is an adjective and cannot stand alone. Don't use the phrase Apple UNIX or Apple's UNIX system. When referring to Apple's version of the UNIX operating system, use A/UX. 
  685.  
  686. unprotectDon't use; use remove protection. 
  687.  
  688. unselected (adj.)Use to describe something that has not yet been selected. Not deselected or dehighlighted. Compare deselect; unhighlighted. 
  689.  
  690. Up ArrowThe key. When referring to more than one of the arrow keys, arrow is lowercase (as in the arrow keys). 
  691. uppercase (n., adj.)One word, no hyphen. (Exception to American Heritage.) When used in conjunction with lowercase as a noun (or to modify a noun), use uppercase and lowercase (both words spelled out, in that order). 
  692.  
  693. upper left (n.), upper-left (adj.)Note hyphenation of adjective. Don't use upper left-hand or top left.  
  694.  
  695. upper right (n.), upper-right (adj.)Note hyphenation of adjective. Don't use upper right-hand or top right. 
  696.  
  697. upside-down (adj.)Note hyphenation. 
  698.  
  699. upwardNot upwards. 
  700.  
  701. U.S.Note periods. (Exception to the rule that abbreviations do not include periods.) 
  702.  
  703. user groupNot users group or user's group. 
  704.  
  705. user nameTwo words. Note the spelling of these similar terms: device name, filename, pathname, volume name. 
  706.  
  707. versionLowercase, as in AppleShare version 1.1. 
  708.  
  709. versusNot vs. Rewrite to avoid using versus when possible. 
  710.  
  711. videocableNot videocord or monitorcable. 
  712.  
  713. videojackNot videoconnector. 
  714.  
  715. videomonitorNot televisionmonitor or TVmonitor. After first occurrence, it's OK to shorten the term to monitor. 
  716.  
  717. video slotDon't use; use auxiliary slot for the special slot on the Apple IIe. 
  718.  
  719. viewportOne word. Don't use when you mean window.  
  720.  
  721. volumenameTwo words. In specific references, capitalization should agree with the directory listing: the volume named PERSONNEL.   
  722. Note the treatment of these similar terms: device name, filename, pathname, user name. 
  723.  
  724. volumesBooks are divided into volumes when page length exceeds manageable limits. Different volumes don't have different titles because the division into volumes doesn't represent a difference in subject matter. Use arabic numerals for volume numbers. 
  725.     Volume1, Volume2 
  726. Inside Macintosh is an exception to this rule; its volume numbers are roman.
  727.     Volume IV of Inside Macintosh
  728. In cross-references to specific volumes, capitalize but don't italicize Volume. 
  729.     See Volume 1 of the Applesoft BASIC Programmer's Reference Manual for more information. 
  730. See also parts. 
  731.  
  732. vs.Don't use; use versus when absolutely necessary. 
  733. warmstart (n.),warm-start (adj.)Note hyphenation of adjective. 
  734.  
  735. waveform (n., adj.)One word. 
  736.  
  737. wavelength (n.)One word. 
  738.  
  739. weDon't use first person; rewrite in terms of the reader or the product. 
  740.  
  741. whichUse only to introduce an unrestrictive clause; clauses beginning with which are always set off with commas. Compare that. 
  742.  
  743.     Correct: The largest house in town, which Jack's sister built, is also the newest. [There is only one largest house; the phrase which Jack's sister built, while it provides more information, does not restrict (narrow the meaning of) the subject of the sentence.] 
  744.     Correct: This is the house that Jack built. [There are many houses; the phrase that Jack built restricts the subject of the sentence to one house.] 
  745.  
  746. whirNot whirr. But whirring. 
  747.     The disk drive whirs; in a moment you'll see the opening display on the screen. 
  748.  
  749. wide area networkThree words. 
  750.  
  751. windoidDon't use; use mini-window.
  752.  
  753. windowWhen an icon is opened, what appears on the screen is called a window, not an open window. Inactive windows or objects are in back of or behind active windows. Compare mini-window. 
  754.  
  755. window zoomingNote lowercase. No hyphen. 
  756.  
  757. word processing (n.), word-processing (adj.)Note hyphenation of adjective. 
  758.  
  759. wordsaswordsItalicize a word when it is used as a word. Use an apostrophe and an s to form the plural, but don't italicize the apostrophe or the s. 
  760.     He had too many and 's in the sentence. 
  761.  
  762. word wrapNot wraparound or word wraparound. In manuals written for new users, however, you may want to mention the term wraparo
  763. und or include it in your glossary because users may see it elsewhere. 
  764. work fileTwo words, except in reference to the Pascal predefined file type workfile. 
  765.  
  766. workstation (n., adj.)One word. 
  767.  
  768. wraparound (n.)Don't use; use word wrap.
  769.  
  770. write-enablenotchNot write-protectnotch. Note hyphenation. Refers to the notch on 5.25-inch disks only. 
  771.  
  772. write-protect (v., adj.), write-protected (adj., pred. adj.), write-protection (n.)Hyphenated in all forms. 
  773.     You use the write-protect tab to write-protect a disk. 
  774.     When a disk is write-protected, it can't be changed. 
  775.     Sometimes it's necessary to remove the write-protection from a disk. 
  776. Compare copy-protect, copy-protected, copy-protection. 
  777.  
  778. xWhen used as a place holder for replaceable numbers, x is lowercase and plain style. 
  779.     $02xx [represents a range of Memory Manager errors] 
  780. Don't use x 's as place holders in numbers representing microprocessors. 
  781.     Incorrect: 68xxx microprocessor 
  782.     Correct: 68000-family microprocessor 
  783.  
  784. XON/XOFFAll caps. Refers to the handshake. 
  785.  
  786. zerocharacterOK for the ASCII character $30. Don't confuse with nullcharacter ($00). 
  787.  
  788. zerosNot zeroes. 
  789.  
  790. zipcodeNote lowercase. 
  791.  
  792. zoom boxTwo words. Note lowercase. 
  793.  
  794. zoom-window boxNote lowercase and hyphenation. 
  795.  
  796.  
  797.  
  798.  
  799.  
  800.  
  801. A    P    P    E    N    D    I    X    A
  802.  
  803. Technical Notation
  804. This appendix gives special style and usage rules that apply largely 
  805. or exclusively to technical documentation. (These rules are also included by topic in the main body of this guide.) 
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825.  
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858. General considerations 
  859. When writing about a particular programming language, be careful to follow the capitalization style of that language. 
  860. Be sure to explain in the preface how your book uses capitalization and typography. If you use special text elements, such as tag boxes, incidental boxes, or marginal glosses, it's usually a good idea to explain your conventions for these elements as well. 
  861.  
  862. Code
  863. Use computer voice for code. 
  864. If the language you're working with has a standard style of indentation, use it. If it doesn't have such a style, develop a logical method of your own and use it consistently. 
  865.     WHILE i<63 DO        BEGIN            IF odd(i) THEN z := z*w            ELSE z := y        END
  866. Develop a method of spacing around punctuation and use it consistently. It's often best to use "English-style" spacing because it's easy to remember and stick with. 
  867.  
  868.     (height, width: extended; quo: integer);    PageSize = 1024
  869.  
  870. Syntax descriptions
  871. Use computer voice for literals (parts of the language, values, and so on), regular text font italics for metasymbols (artificial terms that have meaning only in your book and are to be replaced by a value or symbol), and plain style regular text font for brackets that enclose something that's optional. Pay close attention to punctuation. 
  872.     Read ([file, ] var) 
  873. Use a hyphen or an embedded cap to connect two words that act as a single metasymbol. 
  874.     Correct: source-file or sourceFile
  875.     Incorrect: sourcefile or source_file 
  876. The hyphen is preferred to the embedded cap because it avoids confusion of the metasymbol with a Macintosh routine name. 
  877. Be consistent when naming metasymbols; for example, don't alternate between commands and command-list. 
  878.  
  879. Computer voice in text
  880. Whether to use computer voice in text is a matter of judgment. Use computer voice only if your manual would be confusing without it; for example, if your manual has at least several instances in which a word from a programming language might be mistaken for an English word. If a programming language has a capitalization convention that already distinguishes such words, however, computer voice need not be used. 
  881.  
  882. Likely places for computer voice in text would be language manuals, A/UX references, and other highly technical manuals. (In most other kinds of manuals, words that would be candidates for computer voice are usually routine names and field names, which have a capitalization style that already distinguishes them.) 
  883. If you decide that you need computer voice in text, use it for all text fragments that the reader should construe as expressions in a programming language. For example, in a language manual you would use computer voice for such elements as data types, reserved words, operators, quoted constants, nonnumeric values, and identifiers (names for variables, routines, and so on)-that is, anything that should be read as code. 
  884. Be aware that some words have more than one meaning in some manuals, such as real in computer voice for the data type and in regular text font for the class of types in MPW Pascal. 
  885. You may choose to use computer voice for the names of files, volumes, directories, and libraries, especially in reference books for languages and development systems where the filenames are names of pieces of code. 
  886.     /CIIgsLibraries/Start.obj
  887.     /etc/sysinitrc 
  888. Such names are a special case because they are not part of executable code. 
  889. In general, don't use a routine name as a verb. 
  890.     Correct: Run ls on both directories. 
  891.     Incorrect: ls both directories. 
  892.     Correct: Change to the root directory. 
  893.     Incorrect: cd to the root directory. 
  894. But when a routine name is also an English word and is well established as a verb with your audience, it's OK to use the name as a verb; use regular text font for this purpose. The verb in this example would be recognized by A/UX readers as concatenate: 
  895.     Correct: Cat your file. 
  896.     Incorrect: cat your file. 
  897. Avoid mixing fonts within a single word. Rewrite to avoid forming the plural of a word in computer voice. 
  898.     Correct: values of type integer 
  899.     Incorrect: integers 
  900. Punctuation following a word or phrase in computer voice is in regular text font, not in computer voice, unless the punctuation mark is part of the computer-language element represented. 
  901.     NAN(004), nan(4), and NaN are examples of acceptable     input. 
  902. Use computer voice spaces before and after a word or phrase in computer voice. (Computer voice spaces are wider than regular text font spaces.) 
  903.  
  904. Metasymbols in text
  905. In running text, use regular text font italics when referring to a metasymbol (that is, an artificial term that has meaning only in your manual and is to be replaced by a value or symbol), and spell out the metasymbol just as it would appear in a syntax description. Use plain style when using the name of a metasymbol as ordinary prose. 
  906.     Correct: volume-name may have up to 12 characters. 
  907.     Correct: The volume name may have up to 12 characters. 
  908.     Incorrect: The volume-name may have up to 12 characters. 
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.  
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957. A    P    P    E    N    D    I    X    B 
  958.  
  959. Units of Measurement 
  960. THIS APPENDIX LISTS UNITS OF MEASUREMENT LIKELY TO OCCUR IN A COMPUTER
  961. manual. For each unit, both the full term and the abbreviation are given, along with the quantity for which the unit is used.  
  962.  
  963. Guidelines 
  964. Use the full term for a unit of measurement in text; abbreviations are fine in technical appendixes, specification lists, and tables.  
  965. Abbreviations for metric units are not followed by a period; abbreviations for English units are followed by a period. In general, units of measurement derived from a proper name are not capitalized when spelled out, but their abbreviations are capitalized.  
  966. Use the same abbreviation for both the singular and the plural form of a unit of measurement. Exceptions to this rule are the abbreviations Kbit, Kbyte, and Mbit, which take the forms Kbits, Kbytes, and Mbits when used as abbreviations for kilobits, kilobytes, and megabits.  
  967. When using a numeral and a unit of measurement as a compound adjective, hyphenate the compound even when the unit is abbreviated. Exceptions to this rule are the abbreviation K, which is closed up with the numeral even when it is used to form an adjective, and the abbreviation MB, which is left open even when it is used to form an adjective.  
  968. When an abbreviation includes a nonalphanumeric character, the keystroke sequence necessary to generate that character is included in brackets after the abbreviation.  
  969.  
  970.  
  971.  
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005. Unit     Abbreviation     Quantity 
  1006. __________________________________________________________________________________________
  1007. ampere     A or amp     electric current ampere-hour     
  1008. Ah     rate of delivery of electricity ampere per meter     
  1009. A/m     magnetic field strength ampere per volt. See siemens ampere-second. See coulomb angstrom (10-10 meters)     
  1010. A [Option-Shift-A]     optical wavelength attoampere (10-18 amperes)     
  1011. aA     electric current baud (signal events per second)     
  1012. baud      speed of data transmission bel (10 decibels)     
  1013. B     sound intensity bits per second     
  1014. bps     speed of data transmission  
  1015. calorie (thermochemical calorie)     cal or C     heat candela (or candle)     
  1016. cd [with metric     luminous intensity         units] or cd.         [with English         units] candela per square inch     
  1017. cd./sq. in.     luminance candela per square meter     
  1018. cd/m2     luminance centimeter     
  1019. cm     length centimeter per second per    second. See gal 
  1020. characters per inch     cpi     letter spacing (in type) 
  1021. characters per second     cps     printing speed (on nonlaser printers) 
  1022. coulomb (ampere-second)     C     electric charge coulomb per volt. See farad cubic centimeter     cm3     volume cubic foot     
  1023. cu. ft.     volume cubic foot per minute     cu. ft./min.     change in volume over time cubic foot per second     cu. ft./sec.     change in volume over time cubic inch     cu. in.     volume cubic meter     m3     volume cubic meter per second     m3/s      change in volume over time cubic yard     cu. yd.     volume cycle     c     complete execution of a periodically                repeated phenomenon cycle per second. See hertz decibel (0.10 bels)     dB     sound intensity degree     o [Option-Shift-8]     angular measure degree Celsius     oC [Option-Shift-8]     temperature degree Fahrenheit     oF [Option-Shift-8]     temperature degree Kelvin. See kelvin degree Rankine     oR [Option-Shift-8]     temperature dyne     dyn     force
  1024. Unit     Abbreviation     Quantity
  1025. __________________________________________________________________________________________
  1026. electromotive force     emf     energy derived from electrical source                per unit quantity of electricity electron volt     eV     energy erg     erg     workfarad (coulomb per volt)     F     capacitance foot     ft.     length foot per minute     ft./min.     velocity foot per second     ft./sec.     velocity foot per second squared     ft./sq. sec.     acceleration gal (centimeter per second      gal     acceleration, especially that    per second)             due to gravity  gallon     gal.     volume gauss     G     magnetic induction gigabit    Gbit    computer memorygigabyte    GB    computer memorygigaelectron-volt (109     GeV      energy   electron volts) gigahertz (109 hertz)     GHz     frequency gilbert     Gb     magnetomotive force gram     g     mass, weight gram per cubic centimeter     g/cm3     density henry     H     inductance hertz (cycle per second)     Hz     frequency horsepower     HP     power hour     h [with metric units]     time         or hr. [with English         units] inch     in.     length inch per second     in./sec.     velocity joule (kilogram-meter)     J     energy joule per second. See watt kelvin     K     temperature kilobit     Kbit     computer memory kilobyte     K or KB     computer memory kilogauss (103 gauss)     kG    magnetic induction kilogram (103 grams)     kg    mass, weight kilogram-meter. See joule kilogram-meter per second   squared. See newton kilogram per cubic meter     kg/m3     density kilohertz (103 hertz)     kHz     frequency kilohm (103 ohms)     kO [Option-Z]     electric resistance kilometer (103 meters)     km     length, distance kilometer per hour     kph or KPH     velocity
  1027. Unit     Abbreviation     Quantity
  1028. __________________________________________________________________________________________
  1029. kilovolt (103 volts)     kV     electric potential kilovolt-ampere. See kilowatt kilowatt (kilovolt-ampere)     kW     power kilowatt-hour     kWh     energy (usually electric power                consumption) liter     l     volume liter per second     l/s     change in volume over time lumen     lm     flux of light lumen per square   centimeter. See phot lux     lx     illumination maxwell (10-8 webers)     Mx     magnetic flux megabit     Mbit     computer memory megabyte     MB     computer memory megaelectron-volt (106      MeV     energy   electron volts) megahertz (106 hertz)     MHz     frequency megohm (106 ohms)     MO [Option-Z]     electric resistance meter     m     length, distance meter per second     m/s     velocity meter per second squared     m/s2     acceleration microampere (10-6 amperes)     uA [Option-M]     electric current microfarad (10-6 farads)     uF [Option-M]     capacitance microgram (10-6 grams)     ug [Option-M]     mass, weight microhenry (10-6 henrys)     uH [Option-M]     inductance microliter (10-6 liters)     ul [Option-M]     volume micron or micrometer      um [Option-M]     length   (10-6 meters) mil (10-3 inches)     mil     length mile     mi. [except in mph]     length, distance mile per hour     mph or MPH     velocity milliampere (10-3 amperes)     mA     electric current milligram (10-3 grams)     mg     mass, weight millihenry (10-3 henrys)     mH     inductance milliliter (10-3 liters)     ml     volume millimeter (10-3 meters)     mm     length millimicron. See nanometer millisecond (10-3 seconds)     ms     time millivolt (10-3 volts)     mV     electric potential milliwatt (10-3 watts)     mW     power minute     min.     time month     mo.     time nanoampere (10-9 amperes)     nA     electric current
  1030. Unit     Abbreviation     Quantity
  1031. __________________________________________________________________________________________
  1032. nanofarad (10-9 farads)     nF     capacitance nanometer (10-9 meters)     nm     length nanosecond (10-9 seconds)     ns     time newton (kilogram-meter per      N     force   second squared) newton per square meter. See pascal oersted     Oe     magnetic intensity ohm     O [Option-Z]     electric resistance ounce     oz.     volume, weight pascal (newton per square meter)     Pa     pressure phot (lumen per square centimeter)     ph     illumination picofarad (10-12 farads)     pF     capacitance picowatt (10-12 watts)     pW     power pound     lb.     mass, weight poundal     pdl.     force radian     rad or radian     angular measure radian per second     rad/s     angular velocity radian per second squared     rad/s2     angular acceleration revolution per minute     rpm     angular velocity rod (5.5 yards)     rd.     length second     s [with metric units]      time         or sec. [with English          units] siemens (ampere per volt)     S      conductance slug     slug     mass square foot     sq. ft.     area square inch     sq. in.     area square meter     m2     area square mile     sq. mi.     area square rod     sq. rd.     area square yard     sq. yd.     area tesla (weber per square meter)     T     magnetic flux density ton     tn. or ton     mass, weight volt     V     electric potential volt-ampere. See watt watt (joule per second)     W     power watt-hour     Wh     energy weber     Wb     magnetic flux weber per square meter. See tesla yard     yd.     length, distance year     yr.     time  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053. The Apple Publishing System  
  1054. This Apple manual was written, edited, and composed on a desktop publishing system using Apple Macintoshrcomputers and MicrosoftrWord. Proof pages were created on Apple LaserWriterr printers; final pages were created on the Varityperr VT600t. PostScriptr, the LaserWriter page-description language, was developed by Adobe Systems Incorporated.  
  1055. Text type and display type are Apple's corporate font, a condensed version of Garamond. Bullets are ITC Zapf Dingbatsr. Some elements, such as program listings, are set in Apple Courier, a fixed-width font.  
  1056.